p_sync Milestone 1: Create Sync Client, implement pull operation, CLI, and overloads for log + call #62

AlePouroullis · 2025-05-07T17:25:31Z

Superseded by PR 69
p_sync/base is the auto-generated SDK with my latest backend changes from here. Did this to make the PR focused on the custom code changes.

Create sync client with support for pulling files from the remote humanloop to local workspace). Includes filters for environment and path (where path can specify specific file or directory)
Create CLI with pull command. Uses the click library
Overload .call() and .log() functions to use serialized contents of .prompt/.agent local files when use_local_files is set to true when initializing the humanloop client.
Address edge cases like specifying path + environment or path + version_id. I employ the principle of "explicit is better than implicit", i.e. raise error if user initializes the client with use_local_files=True and tries to reference path + remote-specific information (version_id/environment).
Cache files in memory after loading from disk using LRU cache
Integration tests for sync client, call and log overloading, CLI

How to Use Locally

Prerequisites

Run this backend branch locally

Set up the SDK

Clone this branch
git clone --branch p_sync/pull git@github.com:humanloop/humanloop-python.git

Install dependencies
poetry install

Activate the venv
poetry shell

Test the CLI

In the same directory as this cloned SDK
humanloop pull --base-url http://localhost:80/v5

In another project:

poetry init Use default configuration
In pyproject.toml modify python version constraints to >=3.9,<4
Add the SDK as a dependency.
3a. Get the absolute path to the local SDK using pwd
3b. In your playground project run poetry add --editable <path to SDK>
Then install peer dependencies poetry install
From the virtual environment (poetry shell) you can test the CLI humanloop pull --base-url http://localhost:80/v5

Note that you can remove --base-url entirely as the relevant backend changes are live in prod.

Sync client requires dotenv at runtime

.fernignore

pyproject.toml

andreibratu · 2025-05-08T17:26:46Z

pyproject.toml

 line-length = 120

+[tool.poetry.scripts]
+humanloop = "humanloop.cli.__main__:cli"


integration test: use subprocess to check if cli works

check if exit code 0 when calling cli command; maybe check for exit code 1 when api key not provided

src/humanloop/cli/__main__.py

andreibratu · 2025-05-08T17:37:49Z

src/humanloop/cli/__main__.py

+
+    \b
+    This command will:
+    1. Fetch prompt and agent files from your Humanloop workspace


Suggested change

1. Fetch prompt and agent files from your Humanloop workspace

1. Fetch serializable files from your Humanloop workspace.

I've decided against this as I don't think users will understand what 'serializable' means.

src/humanloop/cli/__main__.py

andreibratu · 2025-05-08T17:44:20Z

src/humanloop/cli/__main__.py

+            successful_files = sync_client.pull(path, environment)
+
+    # Get metadata about the operation
+    metadata = sync_client.metadata.get_last_operation()


follow-up with a loom

src/humanloop/cli/__main__.py

andreibratu · 2025-05-08T17:47:15Z

src/humanloop/cli/__main__.py

+                for file in metadata['successful_files']:   
+                    click.echo(click.style(f"  ✓ {file}", fg=SUCCESS_COLOR))
+            else:
+                files_to_display = metadata['successful_files'][:MAX_FILES_TO_DISPLAY]


if len(failed_failes) > 0, cancel the operation, inform user via message in terminal, exit 1

The problem I'm seeing with this is it would make things quite complex to support transactions, i.e. allow rollbacks if one file fails.

src/humanloop/cli/__main__.py

src/humanloop/cli/progress.py

src/humanloop/overload.py

olehvell-h · 2025-05-12T17:02:34Z

humanloop.core.api_error.ApiError: status_code: 401, body: {'detail': 'Could not validate credentials.'}

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/Users/oleh/humanloop/playground/test-sdk/letscallhllocally.py", line 9, in <module>
    xx = humanloop.prompts.call(path="/Oleh's space/Customer Support bot.prompt")
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/oleh/humanloop/test-sync-sdk/humanloop-python/src/humanloop/overload.py", line 204, in call_wrapper
    return _overload_call(self, sync_client, use_local_files, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/oleh/humanloop/test-sync-sdk/humanloop-python/src/humanloop/overload.py", line 175, in _overload_call
    raise HumanloopRuntimeError from e
humanloop.error.HumanloopRuntimeError

I think there is an error that we don't handle properly. Would expect to see "humanloop.core.api_error.ApiError: status_code: 401, body: {'detail': 'Could not validate credentials.'}" as first line, not

....
  File "/Users/oleh/humanloop/test-sync-sdk/humanloop-python/src/humanloop/overload.py", line 204, in call_wrapper
    return _overload_call(self, sync_client, use_local_files, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/oleh/humanloop/test-sync-sdk/humanloop-python/src/humanloop/overload.py", line 175, in _overload_call
    raise HumanloopRuntimeError from e
humanloop.error.HumanloopRuntimeError

olehvell-h · 2025-05-12T17:08:09Z

I made a typo and new file was created on HL. Curious whether it makes sense to have strict mode, where creating new files (or even versions) is not allowed if use_local_files=True . Don't want to expand scope, just sharing my observations

src/humanloop/client.py

.gitignore

andreibratu · 2025-05-12T18:14:35Z

pyproject.toml

-version = "0.8.36"
-description = ""
+version = "0.8.39"
+description = "Humanloop Python SDK"


have you changes this? this is auto-generated by fen

This file's autogenerated by fern? Oops, thought we'd be able to modify project metadata.

andreibratu · 2025-05-12T18:17:25Z

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]


note: i have updated humanloop-docs with the pytest-xdist dependency; we'll regenerate the sdk and rebase this PR on top of it before merging

Thanks 🙏

src/humanloop/cli/__main__.py

src/humanloop/client.py

src/humanloop/files/raw_client.py

src/humanloop/files/client.py

…s cleanup

…o 100

fern-api bot and others added 2 commits May 7, 2025 17:14

Release 0.8.36

b01e6f4

Merge custom code

e3a524e

AlePouroullis changed the base branch from master to p_sync/base May 7, 2025 17:29

Update poetry.lock

689880c

AlePouroullis changed the title ~~P sync/pull~~ Create Sync Client, implement pull operation, CLI, and overloads for log + call May 7, 2025

AlePouroullis changed the title ~~Create Sync Client, implement pull operation, CLI, and overloads for log + call~~ p_sync Milestone 1: Create Sync Client, implement pull operation, CLI, and overloads for log + call May 7, 2025

AlePouroullis added 2 commits May 7, 2025 18:39

Remove trailing slashes in .fernignore for consistency

68d75be

Move python-dotenv from dev to runtime dependencies

5be41cb

Sync client requires dotenv at runtime

AlePouroullis requested review from andreibratu and harry-humanloop May 8, 2025 14:22